Constructors
constructor
- new API(__namedParameters?): API
Parameters
Optional__namedParameters: Partial<Options>
Returns API
Accessors
auth
- get auth(): AxiosRequestConfig<any>
Returns AxiosRequestConfig<any>
config
- get config(): AxiosRequestConfig<any>
Returns AxiosRequestConfig<any>
Methods
delete
- delete<Path, Route>(path, params?, config?): Promise<Route["response"]>
Type Parameters
- Path extends
| "/auth/mfa/totp"
| `/bots/${string}`
| `/channels/${string}`
| "-/channels/{target}"
| `/channels/${string}/messages/${string}`
| "-/channels/{target}/messages/{msg}"
| `/servers/${string}/roles/${string}`
| "-/servers/{target}/roles/{role_id}"
| `/invites/${string}`
| "-/invites/{target}"
| `/custom/emoji/${string}`
| "-/custom/emoji/{emoji_id}"
| `/users/${string}/friend`
| "-/users/{target}/friend"
| `/users/${string}/block`
| "-/users/{target}/block"
| "-/bots/{target}"
| `/channels/${string}/messages/bulk`
| "-/channels/{target}/messages/bulk"
| `/channels/${string}/recipients/${string}`
| "-/channels/{target}/recipients/{member}"
| `/channels/${string}/messages/${string}/reactions/${string}`
| "-/channels/{target}/messages/{msg}/reactions/{emoji}"
| `/channels/${string}/messages/${string}/reactions`
| "-/channels/{target}/messages/{msg}/reactions"
| `/servers/${string}`
| "-/servers/{target}"
| `/servers/${string}/members/${string}`
| "-/servers/{target}/members/{member}"
| `/servers/${string}/bans/${string}`
| "-/servers/{server}/bans/{target}"
| `/auth/session/${string}`
| "-/auth/session/{id}" - Route extends (
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 3;
path: `/users/${string}/friend`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 3;
path: "-/users/{target}/friend";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "delete";
}
| never
| never
| {
method: "delete";
params: undefined;
parts: 3;
path: `/users/${string}/block`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 3;
path: "-/users/{target}/block";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 2;
path: `/bots/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 2;
path: "-/bots/{target}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: {
leave_silently?: null | boolean;
};
parts: 2;
path: `/channels/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: {
leave_silently?: null | boolean;
};
parts: 2;
path: "-/channels/{target}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 4;
path: `/channels/${string}/messages/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 4;
path: "-/channels/{target}/messages/{msg}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| {
method: "delete";
params: {
ids: string[];
};
parts: 4;
path: `/channels/${string}/messages/bulk`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: {
ids: string[];
};
parts: 4;
path: "-/channels/{target}/messages/bulk";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 4;
path: `/channels/${string}/recipients/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 4;
path: "-/channels/{target}/recipients/{member}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: {
remove_all?: null | boolean;
user_id?: null | string;
};
parts: 6;
path: `/channels/${string}/messages/${string}/reactions/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: {
remove_all?: null | boolean;
user_id?: null | string;
};
parts: 6;
path: "-/channels/{target}/messages/{msg}/reactions/{emoji}";
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 5;
path: `/channels/${string}/messages/${string}/reactions`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 5;
path: "-/channels/{target}/messages/{msg}/reactions";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: {
leave_silently?: null | boolean;
};
parts: 2;
path: `/servers/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: {
leave_silently?: null | boolean;
};
parts: 2;
path: "-/servers/{target}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 4;
path: `/servers/${string}/members/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 4;
path: "-/servers/{target}/members/{member}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 4;
path: `/servers/${string}/bans/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 4;
path: "-/servers/{server}/bans/{target}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 4;
path: `/servers/${string}/roles/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 4;
path: "-/servers/{target}/roles/{role_id}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 2;
path: `/invites/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 2;
path: "-/invites/{target}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 3;
path: `/custom/emoji/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 3;
path: "-/custom/emoji/{emoji_id}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: {
revoke_self?: null | boolean;
};
parts: 3;
path: "/auth/session/all";
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 3;
path: `/auth/session/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 3;
path: "-/auth/session/{id}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 3;
path: "/auth/mfa/totp";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never) & {
parts: Count<Path, "/", []>;
path: Path;
}
Parameters
- path: Path
Optionalparams: anyOptionalconfig: AxiosRequestConfig<any>
Returns Promise<Route["response"]>
Typed Response Data
- delete<Path, Route>(path, params?): Promise<Route["response"]>
Type Parameters
- Path extends
| "/auth/mfa/totp"
| `/bots/${string}`
| `/channels/${string}/messages/${string}`
| "-/channels/{target}/messages/{msg}"
| `/servers/${string}/roles/${string}`
| "-/servers/{target}/roles/{role_id}"
| `/invites/${string}`
| "-/invites/{target}"
| `/custom/emoji/${string}`
| "-/custom/emoji/{emoji_id}"
| `/users/${string}/friend`
| "-/users/{target}/friend"
| `/users/${string}/block`
| "-/users/{target}/block"
| "-/bots/{target}"
| `/channels/${string}/recipients/${string}`
| "-/channels/{target}/recipients/{member}"
| `/channels/${string}/messages/${string}/reactions`
| "-/channels/{target}/messages/{msg}/reactions"
| `/servers/${string}/members/${string}`
| "-/servers/{target}/members/{member}"
| `/servers/${string}/bans/${string}`
| "-/servers/{server}/bans/{target}"
| `/auth/session/${string}`
| "-/auth/session/{id}" - Route extends (
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 3;
path: `/users/${string}/friend`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 3;
path: "-/users/{target}/friend";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "delete";
}
| never
| never
| {
method: "delete";
params: undefined;
parts: 3;
path: `/users/${string}/block`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 3;
path: "-/users/{target}/block";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 2;
path: `/bots/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 2;
path: "-/bots/{target}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: {
leave_silently?: null | boolean;
};
parts: 2;
path: `/channels/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: {
leave_silently?: null | boolean;
};
parts: 2;
path: "-/channels/{target}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 4;
path: `/channels/${string}/messages/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 4;
path: "-/channels/{target}/messages/{msg}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| {
method: "delete";
params: {
ids: string[];
};
parts: 4;
path: `/channels/${string}/messages/bulk`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: {
ids: string[];
};
parts: 4;
path: "-/channels/{target}/messages/bulk";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 4;
path: `/channels/${string}/recipients/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 4;
path: "-/channels/{target}/recipients/{member}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: {
remove_all?: null | boolean;
user_id?: null | string;
};
parts: 6;
path: `/channels/${string}/messages/${string}/reactions/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: {
remove_all?: null | boolean;
user_id?: null | string;
};
parts: 6;
path: "-/channels/{target}/messages/{msg}/reactions/{emoji}";
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 5;
path: `/channels/${string}/messages/${string}/reactions`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 5;
path: "-/channels/{target}/messages/{msg}/reactions";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: {
leave_silently?: null | boolean;
};
parts: 2;
path: `/servers/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: {
leave_silently?: null | boolean;
};
parts: 2;
path: "-/servers/{target}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 4;
path: `/servers/${string}/members/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 4;
path: "-/servers/{target}/members/{member}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 4;
path: `/servers/${string}/bans/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 4;
path: "-/servers/{server}/bans/{target}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 4;
path: `/servers/${string}/roles/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 4;
path: "-/servers/{target}/roles/{role_id}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 2;
path: `/invites/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 2;
path: "-/invites/{target}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 3;
path: `/custom/emoji/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 3;
path: "-/custom/emoji/{emoji_id}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: {
revoke_self?: null | boolean;
};
parts: 3;
path: "/auth/session/all";
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 3;
path: `/auth/session/${string}`;
response: undefined;
} & {
method: "delete";
}
| {
method: "delete";
params: undefined;
parts: 3;
path: "-/auth/session/{id}";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "delete";
params: undefined;
parts: 3;
path: "/auth/mfa/totp";
response: undefined;
} & {
method: "delete";
}
| never
| never
| never
| never
| never
| never
| never) & {
parts: Count<Path, "/", []>;
path: Path;
}
Parameters
- path: Path
Optionalparams: any
Returns Promise<Route["response"]>
Typed Response Data
get
- get<Path, Route>(path, params, config?): Promise<Route["response"]>
Type Parameters
- Path extends
| "/"
| "/auth/session/all"
| `/users/${string}`
| "-/users/{target}"
| `/users/${string}/flags`
| "-/users/{target}/flags"
| `/users/${string}/default_avatar`
| "-/users/{target}/default_avatar"
| `/users/${string}/profile`
| "-/users/{target}/profile"
| `/users/${string}/dm`
| "-/users/{target}/dm"
| `/users/${string}/mutual`
| "-/users/{target}/mutual"
| `/bots/${string}/invite`
| "-/bots/{target}/invite"
| `/bots/${string}`
| "-/bots/{bot}"
| `/channels/${string}`
| "-/channels/{target}"
| `/channels/${string}/members`
| "-/channels/{target}/members"
| `/channels/${string}/messages/${string}`
| "-/channels/{target}/messages/{msg}"
| `/channels/${string}/webhooks`
| "-/channels/{channel_id}/webhooks"
| `/servers/${string}/bans`
| "-/servers/{target}/bans"
| `/servers/${string}/invites`
| "-/servers/{target}/invites"
| `/servers/${string}/roles/${string}`
| "-/servers/{target}/roles/{role_id}"
| `/servers/${string}/emojis`
| "-/servers/{target}/emojis"
| `/invites/${string}`
| "-/invites/{target}"
| `/custom/emoji/${string}`
| "-/custom/emoji/{emoji_id}"
| "/auth/account/"
| "/auth/mfa/"
| "/auth/mfa/methods"
| "/onboard/hello"
| "/sync/unreads"
| `/channels/${string}/messages`
| "-/channels/{target}/messages"
| `/servers/${string}`
| "-/servers/{target}"
| `/servers/${string}/members`
| "-/servers/{target}/members"
| `/servers/${string}/members/${string}`
| "-/servers/{target}/members/{member}"
| `/servers/${string}/members_experimental_query`
| "-/servers/{target}/members_experimental_query" - Route extends (
| {
method: "get";
params: undefined;
parts: 1;
path: "/";
response: {
app: string;
build: {
commit_sha: string;
commit_timestamp: string;
origin_url: string;
semver: string;
timestamp: string;
};
features: {
autumn: {
enabled: boolean;
url: string;
};
captcha: {
enabled: boolean;
key: string;
};
email: boolean;
invite_only: boolean;
january: {
enabled: boolean;
url: string;
};
voso: {
enabled: boolean;
url: string;
ws: string;
};
};
revolt: string;
vapid: string;
ws: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "/users/@me";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: `/users/${string}`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "-/users/{target}";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "get";
}
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/users/${string}/flags`;
response: {
flags: number;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/users/{target}/flags";
response: {
flags: number;
};
} & {
method: "get";
}
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/users/${string}/default_avatar`;
response: string;
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/users/{target}/default_avatar";
response: string;
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: `/users/${string}/profile`;
response: {
background?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
content?: null | string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/users/{target}/profile";
response: {
background?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
content?: null | string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "/users/dms";
response: (
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)]["OverrideField"];
};
server: string;
})[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: `/users/${string}/dm`;
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/users/{target}/dm";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: `/users/${string}/mutual`;
response: {
servers: string[];
users: string[];
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/users/{target}/mutual";
response: {
servers: string[];
users: string[];
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/bots/${string}/invite`;
response: {
_id: string;
avatar?: string;
description?: string;
username: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/bots/{target}/invite";
response: {
_id: string;
avatar?: string;
description?: string;
username: string;
};
} & {
method: "get";
}
| never
| never
| {
method: "get";
params: undefined;
parts: 2;
path: `/bots/${string}`;
response: {
bot: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
};
user: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "-/bots/{bot}";
response: {
bot: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
};
user: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "/bots/@me";
response: {
bots: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 2;
path: `/channels/${string}`;
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "-/channels/{target}";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "get";
}
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/channels/${string}/members`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/channels/{target}/members";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
} & {
method: "get";
}
| never
| never
| {
method: "get";
params: {
after?: null | string;
before?: null | string;
include_users?: null | boolean;
limit?: null | number;
nearby?: null | string;
sort?:
| null
| "Relevance"
| "Latest"
| "Oldest";
};
parts: 3;
path: `/channels/${string}/messages`;
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: ...;
description?: ...;
icon_url?: ...;
image?: ...;
original_url?: ...;
site_name?: ...;
special?: ...;
title?: ...;
type: ...;
url?: ...;
video?: ...;
}
| {
height: ...;
size: ...;
type: ...;
url: ...;
width: ...;
}
| {
height: ...;
type: ...;
url: ...;
width: ...;
}
| {
colour?: ...;
description?: ...;
icon_url?: ...;
media?: ...;
title?: ...;
type: ...;
url?: ...;
}
| {
type: ...;
})[];
interactions?: {
reactions?: null | (...)[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
}[] | {
members?: null | {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
joined_at: string;
nickname?: null | string;
roles?: (...)[];
timeout?: null | string;
}[];
messages: {
_id: string;
attachments?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| (...)
| (...)
| (...)
| (...)
| (...))[];
interactions?: {
reactions?: (...) | (...) | (...);
restrict_reactions?: (...) | (...) | (...);
};
masquerade?: null | {
avatar?: (...) | (...) | (...);
colour?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: (...)[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: (...) | (...) | (...);
name: string;
};
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: {
after?: null | string;
before?: null | string;
include_users?: null | boolean;
limit?: null | number;
nearby?: null | string;
sort?:
| null
| "Relevance"
| "Latest"
| "Oldest";
};
parts: 3;
path: "-/channels/{target}/messages";
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: ...;
description?: ...;
icon_url?: ...;
image?: ...;
original_url?: ...;
site_name?: ...;
special?: ...;
title?: ...;
type: ...;
url?: ...;
video?: ...;
}
| {
height: ...;
size: ...;
type: ...;
url: ...;
width: ...;
}
| {
height: ...;
type: ...;
url: ...;
width: ...;
}
| {
colour?: ...;
description?: ...;
icon_url?: ...;
media?: ...;
title?: ...;
type: ...;
url?: ...;
}
| {
type: ...;
})[];
interactions?: {
reactions?: null | (...)[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
}[] | {
members?: null | {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
joined_at: string;
nickname?: null | string;
roles?: (...)[];
timeout?: null | string;
}[];
messages: {
_id: string;
attachments?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| (...)
| (...)
| (...)
| (...)
| (...))[];
interactions?: {
reactions?: (...) | (...) | (...);
restrict_reactions?: (...) | (...) | (...);
};
masquerade?: null | {
avatar?: (...) | (...) | (...);
colour?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: (...)[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: (...) | (...) | (...);
name: string;
};
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "get";
}
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 4;
path: `/channels/${string}/messages/${string}`;
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 4;
path: "-/channels/{target}/messages/{msg}";
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/channels/${string}/webhooks`;
response: {
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
channel_id: string;
id: string;
name: string;
permissions: number;
token?: null | string;
}[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/channels/{channel_id}/webhooks";
response: {
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
channel_id: string;
id: string;
name: string;
permissions: number;
token?: null | string;
}[];
} & {
method: "get";
}
| never
| {
method: "get";
params: {
include_channels?: null | boolean;
};
parts: 2;
path: `/servers/${string}`;
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
} | {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "get";
}
| {
method: "get";
params: {
include_channels?: null | boolean;
};
parts: 2;
path: "-/servers/{target}";
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
} | {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: {
exclude_offline?: null | boolean;
};
parts: 3;
path: `/servers/${string}/members`;
response: {
members: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: {
exclude_offline?: null | boolean;
};
parts: 3;
path: "-/servers/{target}/members";
response: {
members: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: {
roles?: null | boolean;
};
parts: 4;
path: `/servers/${string}/members/${string}`;
response: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
} | {
member: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
};
roles: {
[key: string]: components["schemas"]["Role"];
};
};
} & {
method: "get";
}
| {
method: "get";
params: {
roles?: null | boolean;
};
parts: 4;
path: "-/servers/{target}/members/{member}";
response: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
} | {
member: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
};
roles: {
[key: string]: components["schemas"]["Role"];
};
};
} & {
method: "get";
}
| never
| never
| never
| never
| {
method: "get";
params: {
experimental_api: boolean;
query: string;
};
parts: 3;
path: `/servers/${string}/members_experimental_query`;
response: {
members: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: {
experimental_api: boolean;
query: string;
};
parts: 3;
path: "-/servers/{target}/members_experimental_query";
response: {
members: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
};
} & {
method: "get";
}
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/servers/${string}/bans`;
response: {
bans: {
_id: {
server: string;
user: string;
};
reason?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
discriminator: string;
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/servers/{target}/bans";
response: {
bans: {
_id: {
server: string;
user: string;
};
reason?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
discriminator: string;
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: `/servers/${string}/invites`;
response: ({
_id: string;
channel: string;
creator: string;
server: string;
type: "Server";
} | {
_id: string;
channel: string;
creator: string;
type: "Group";
})[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/servers/{target}/invites";
response: ({
_id: string;
channel: string;
creator: string;
server: string;
type: "Server";
} | {
_id: string;
channel: string;
creator: string;
type: "Group";
})[];
} & {
method: "get";
}
| never
| never
| {
method: "get";
params: undefined;
parts: 4;
path: `/servers/${string}/roles/${string}`;
response: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 4;
path: "-/servers/{target}/roles/{role_id}";
response: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/servers/${string}/emojis`;
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
}[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/servers/{target}/emojis";
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
}[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: `/invites/${string}`;
response: {
channel_description?: null | string;
channel_id: string;
channel_name: string;
code: string;
member_count: number;
server_banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
server_flags?: null | number;
server_icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
server_id: string;
server_name: string;
type: "Server";
user_avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
user_name: string;
} | {
channel_description?: null | string;
channel_id: string;
channel_name: string;
code: string;
type: "Group";
user_avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
user_name: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "-/invites/{target}";
response: {
channel_description?: null | string;
channel_id: string;
channel_name: string;
code: string;
member_count: number;
server_banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
server_flags?: null | number;
server_icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
server_id: string;
server_name: string;
type: "Server";
user_avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
user_name: string;
} | {
channel_description?: null | string;
channel_id: string;
channel_name: string;
code: string;
type: "Group";
user_avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
user_name: string;
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/custom/emoji/${string}`;
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/custom/emoji/{emoji_id}";
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: "/auth/account/";
response: {
_id: string;
email: string;
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: "/auth/session/all";
response: {
_id: string;
name: string;
}[];
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: "/auth/mfa/";
response: {
email_mfa: boolean;
email_otp: boolean;
recovery_active: boolean;
security_key_mfa: boolean;
totp_mfa: boolean;
trusted_handover: boolean;
};
} & {
method: "get";
}
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: "/auth/mfa/methods";
response: ("Password" | "Recovery" | "Totp")[];
} & {
method: "get";
}
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 2;
path: "/onboard/hello";
response: {
onboarding: boolean;
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 2;
path: "/sync/unreads";
response: {
_id: {
channel: string;
user: string;
};
last_id?: null | string;
mentions?: string[];
}[];
} & {
method: "get";
}) & {
parts: Count<Path, "/", []>;
path: Path;
}
Parameters
- path: Path
- params: Route["params"]
Optionalconfig: AxiosRequestConfig<any>
Returns Promise<Route["response"]>
Typed Response Data
- get<Path, Route>(path): Promise<Route["response"]>
Type Parameters
- Path extends
| "/"
| "/auth/session/all"
| `/users/${string}`
| "-/users/{target}"
| `/users/${string}/flags`
| "-/users/{target}/flags"
| `/users/${string}/default_avatar`
| "-/users/{target}/default_avatar"
| `/users/${string}/profile`
| "-/users/{target}/profile"
| `/users/${string}/dm`
| "-/users/{target}/dm"
| `/users/${string}/mutual`
| "-/users/{target}/mutual"
| `/bots/${string}/invite`
| "-/bots/{target}/invite"
| `/bots/${string}`
| "-/bots/{bot}"
| `/channels/${string}`
| "-/channels/{target}"
| `/channels/${string}/members`
| "-/channels/{target}/members"
| `/channels/${string}/messages/${string}`
| "-/channels/{target}/messages/{msg}"
| `/channels/${string}/webhooks`
| "-/channels/{channel_id}/webhooks"
| `/servers/${string}/bans`
| "-/servers/{target}/bans"
| `/servers/${string}/invites`
| "-/servers/{target}/invites"
| `/servers/${string}/roles/${string}`
| "-/servers/{target}/roles/{role_id}"
| `/servers/${string}/emojis`
| "-/servers/{target}/emojis"
| `/invites/${string}`
| "-/invites/{target}"
| `/custom/emoji/${string}`
| "-/custom/emoji/{emoji_id}"
| "/auth/account/"
| "/auth/mfa/"
| "/auth/mfa/methods"
| "/onboard/hello"
| "/sync/unreads" - Route extends (
| {
method: "get";
params: undefined;
parts: 1;
path: "/";
response: {
app: string;
build: {
commit_sha: string;
commit_timestamp: string;
origin_url: string;
semver: string;
timestamp: string;
};
features: {
autumn: {
enabled: boolean;
url: string;
};
captcha: {
enabled: boolean;
key: string;
};
email: boolean;
invite_only: boolean;
january: {
enabled: boolean;
url: string;
};
voso: {
enabled: boolean;
url: string;
ws: string;
};
};
revolt: string;
vapid: string;
ws: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "/users/@me";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: `/users/${string}`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "-/users/{target}";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "get";
}
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/users/${string}/flags`;
response: {
flags: number;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/users/{target}/flags";
response: {
flags: number;
};
} & {
method: "get";
}
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/users/${string}/default_avatar`;
response: string;
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/users/{target}/default_avatar";
response: string;
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: `/users/${string}/profile`;
response: {
background?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
content?: null | string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/users/{target}/profile";
response: {
background?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
content?: null | string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "/users/dms";
response: (
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)]["OverrideField"];
};
server: string;
})[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: `/users/${string}/dm`;
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/users/{target}/dm";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: `/users/${string}/mutual`;
response: {
servers: string[];
users: string[];
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/users/{target}/mutual";
response: {
servers: string[];
users: string[];
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/bots/${string}/invite`;
response: {
_id: string;
avatar?: string;
description?: string;
username: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/bots/{target}/invite";
response: {
_id: string;
avatar?: string;
description?: string;
username: string;
};
} & {
method: "get";
}
| never
| never
| {
method: "get";
params: undefined;
parts: 2;
path: `/bots/${string}`;
response: {
bot: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
};
user: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "-/bots/{bot}";
response: {
bot: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
};
user: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "/bots/@me";
response: {
bots: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 2;
path: `/channels/${string}`;
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "-/channels/{target}";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "get";
}
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/channels/${string}/members`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/channels/{target}/members";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
} & {
method: "get";
}
| never
| never
| {
method: "get";
params: {
after?: null | string;
before?: null | string;
include_users?: null | boolean;
limit?: null | number;
nearby?: null | string;
sort?:
| null
| "Relevance"
| "Latest"
| "Oldest";
};
parts: 3;
path: `/channels/${string}/messages`;
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: ...;
description?: ...;
icon_url?: ...;
image?: ...;
original_url?: ...;
site_name?: ...;
special?: ...;
title?: ...;
type: ...;
url?: ...;
video?: ...;
}
| {
height: ...;
size: ...;
type: ...;
url: ...;
width: ...;
}
| {
height: ...;
type: ...;
url: ...;
width: ...;
}
| {
colour?: ...;
description?: ...;
icon_url?: ...;
media?: ...;
title?: ...;
type: ...;
url?: ...;
}
| {
type: ...;
})[];
interactions?: {
reactions?: null | (...)[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
}[] | {
members?: null | {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
joined_at: string;
nickname?: null | string;
roles?: (...)[];
timeout?: null | string;
}[];
messages: {
_id: string;
attachments?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| (...)
| (...)
| (...)
| (...)
| (...))[];
interactions?: {
reactions?: (...) | (...) | (...);
restrict_reactions?: (...) | (...) | (...);
};
masquerade?: null | {
avatar?: (...) | (...) | (...);
colour?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: (...)[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: (...) | (...) | (...);
name: string;
};
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: {
after?: null | string;
before?: null | string;
include_users?: null | boolean;
limit?: null | number;
nearby?: null | string;
sort?:
| null
| "Relevance"
| "Latest"
| "Oldest";
};
parts: 3;
path: "-/channels/{target}/messages";
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: ...;
description?: ...;
icon_url?: ...;
image?: ...;
original_url?: ...;
site_name?: ...;
special?: ...;
title?: ...;
type: ...;
url?: ...;
video?: ...;
}
| {
height: ...;
size: ...;
type: ...;
url: ...;
width: ...;
}
| {
height: ...;
type: ...;
url: ...;
width: ...;
}
| {
colour?: ...;
description?: ...;
icon_url?: ...;
media?: ...;
title?: ...;
type: ...;
url?: ...;
}
| {
type: ...;
})[];
interactions?: {
reactions?: null | (...)[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
}[] | {
members?: null | {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
joined_at: string;
nickname?: null | string;
roles?: (...)[];
timeout?: null | string;
}[];
messages: {
_id: string;
attachments?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| (...)
| (...)
| (...)
| (...)
| (...))[];
interactions?: {
reactions?: (...) | (...) | (...);
restrict_reactions?: (...) | (...) | (...);
};
masquerade?: null | {
avatar?: (...) | (...) | (...);
colour?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: (...)[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: (...) | (...) | (...);
name: string;
};
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "get";
}
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 4;
path: `/channels/${string}/messages/${string}`;
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 4;
path: "-/channels/{target}/messages/{msg}";
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/channels/${string}/webhooks`;
response: {
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
channel_id: string;
id: string;
name: string;
permissions: number;
token?: null | string;
}[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/channels/{channel_id}/webhooks";
response: {
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
channel_id: string;
id: string;
name: string;
permissions: number;
token?: null | string;
}[];
} & {
method: "get";
}
| never
| {
method: "get";
params: {
include_channels?: null | boolean;
};
parts: 2;
path: `/servers/${string}`;
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
} | {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "get";
}
| {
method: "get";
params: {
include_channels?: null | boolean;
};
parts: 2;
path: "-/servers/{target}";
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
} | {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: {
exclude_offline?: null | boolean;
};
parts: 3;
path: `/servers/${string}/members`;
response: {
members: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: {
exclude_offline?: null | boolean;
};
parts: 3;
path: "-/servers/{target}/members";
response: {
members: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: {
roles?: null | boolean;
};
parts: 4;
path: `/servers/${string}/members/${string}`;
response: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
} | {
member: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
};
roles: {
[key: string]: components["schemas"]["Role"];
};
};
} & {
method: "get";
}
| {
method: "get";
params: {
roles?: null | boolean;
};
parts: 4;
path: "-/servers/{target}/members/{member}";
response: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
} | {
member: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
};
roles: {
[key: string]: components["schemas"]["Role"];
};
};
} & {
method: "get";
}
| never
| never
| never
| never
| {
method: "get";
params: {
experimental_api: boolean;
query: string;
};
parts: 3;
path: `/servers/${string}/members_experimental_query`;
response: {
members: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: {
experimental_api: boolean;
query: string;
};
parts: 3;
path: "-/servers/{target}/members_experimental_query";
response: {
members: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
}[];
};
} & {
method: "get";
}
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/servers/${string}/bans`;
response: {
bans: {
_id: {
server: string;
user: string;
};
reason?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
discriminator: string;
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/servers/{target}/bans";
response: {
bans: {
_id: {
server: string;
user: string;
};
reason?: null | string;
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
discriminator: string;
username: string;
}[];
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: `/servers/${string}/invites`;
response: ({
_id: string;
channel: string;
creator: string;
server: string;
type: "Server";
} | {
_id: string;
channel: string;
creator: string;
type: "Group";
})[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/servers/{target}/invites";
response: ({
_id: string;
channel: string;
creator: string;
server: string;
type: "Server";
} | {
_id: string;
channel: string;
creator: string;
type: "Group";
})[];
} & {
method: "get";
}
| never
| never
| {
method: "get";
params: undefined;
parts: 4;
path: `/servers/${string}/roles/${string}`;
response: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 4;
path: "-/servers/{target}/roles/{role_id}";
response: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/servers/${string}/emojis`;
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
}[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/servers/{target}/emojis";
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
}[];
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: `/invites/${string}`;
response: {
channel_description?: null | string;
channel_id: string;
channel_name: string;
code: string;
member_count: number;
server_banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
server_flags?: null | number;
server_icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
server_id: string;
server_name: string;
type: "Server";
user_avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
user_name: string;
} | {
channel_description?: null | string;
channel_id: string;
channel_name: string;
code: string;
type: "Group";
user_avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
user_name: string;
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 2;
path: "-/invites/{target}";
response: {
channel_description?: null | string;
channel_id: string;
channel_name: string;
code: string;
member_count: number;
server_banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
server_flags?: null | number;
server_icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
server_id: string;
server_name: string;
type: "Server";
user_avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
user_name: string;
} | {
channel_description?: null | string;
channel_id: string;
channel_name: string;
code: string;
type: "Group";
user_avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
user_name: string;
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: `/custom/emoji/${string}`;
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
} & {
method: "get";
}
| {
method: "get";
params: undefined;
parts: 3;
path: "-/custom/emoji/{emoji_id}";
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: "/auth/account/";
response: {
_id: string;
email: string;
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: "/auth/session/all";
response: {
_id: string;
name: string;
}[];
} & {
method: "get";
}
| never
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: "/auth/mfa/";
response: {
email_mfa: boolean;
email_otp: boolean;
recovery_active: boolean;
security_key_mfa: boolean;
totp_mfa: boolean;
trusted_handover: boolean;
};
} & {
method: "get";
}
| never
| never
| {
method: "get";
params: undefined;
parts: 3;
path: "/auth/mfa/methods";
response: ("Password" | "Recovery" | "Totp")[];
} & {
method: "get";
}
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 2;
path: "/onboard/hello";
response: {
onboarding: boolean;
};
} & {
method: "get";
}
| never
| never
| never
| never
| never
| {
method: "get";
params: undefined;
parts: 2;
path: "/sync/unreads";
response: {
_id: {
channel: string;
user: string;
};
last_id?: null | string;
mentions?: string[];
}[];
} & {
method: "get";
}) & {
parts: Count<Path, "/", []>;
path: Path;
}
Returns Promise<Route["response"]>
Typed Response Data
patch
- patch<Path, Route>(path, params, config?): Promise<Route["response"]>
Type Parameters
- Path extends
| "/auth/account/change/password"
| "/auth/account/change/email"
| "/auth/account/reset_password"
| `/users/${string}`
| "-/users/{target}"
| `/bots/${string}`
| `/channels/${string}`
| "-/channels/{target}"
| `/channels/${string}/messages/${string}`
| "-/channels/{target}/messages/{msg}"
| `/servers/${string}/roles/${string}`
| "-/servers/{target}/roles/{role_id}"
| "-/bots/{target}"
| `/servers/${string}`
| "-/servers/{target}"
| `/servers/${string}/members/${string}`
| "-/servers/{server}/members/{target}"
| `/auth/session/${string}`
| "-/auth/session/{id}"
| "/auth/mfa/recovery" - Route extends (
| never
| never
| never
| never
| {
method: "patch";
params: {
avatar?: null | string;
badges?: null | number;
display_name?: null | string;
flags?: null | number;
profile?: null | {
background?: null | string;
content?: null | string;
};
remove?: null | (
| "Avatar"
| "StatusText"
| "StatusPresence"
| "ProfileContent"
| "ProfileBackground")[];
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
};
parts: 2;
path: `/users/${string}`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
avatar?: null | string;
badges?: null | number;
display_name?: null | string;
flags?: null | number;
profile?: null | {
background?: null | string;
content?: null | string;
};
remove?: null | (
| "Avatar"
| "StatusText"
| "StatusPresence"
| "ProfileContent"
| "ProfileBackground")[];
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
};
parts: 2;
path: "-/users/{target}";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "patch";
}
| never
| never
| {
method: "patch";
params: {
password: string;
username: string;
};
parts: 3;
path: "/users/@me/username";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
analytics?: null | boolean;
interactions_url?: null | string;
name?: null | string;
public?: null | boolean;
remove?: null | ("Token" | "InteractionsURL")[];
};
parts: 2;
path: `/bots/${string}`;
response: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
analytics?: null | boolean;
interactions_url?: null | string;
name?: null | string;
public?: null | boolean;
remove?: null | ("Token" | "InteractionsURL")[];
};
parts: 2;
path: "-/bots/{target}";
response: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
archived?: null | boolean;
description?: null | string;
icon?: null | string;
name?: null | string;
nsfw?: null | boolean;
owner?: null | string;
remove?: null | ("Description" | "Icon" | "DefaultPermissions")[];
};
parts: 2;
path: `/channels/${string}`;
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
archived?: null | boolean;
description?: null | string;
icon?: null | string;
name?: null | string;
nsfw?: null | boolean;
owner?: null | string;
remove?: null | ("Description" | "Icon" | "DefaultPermissions")[];
};
parts: 2;
path: "-/channels/{target}";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
content?: null | string;
embeds?: null | {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | string;
title?: null | string;
url?: null | string;
}[];
};
parts: 4;
path: `/channels/${string}/messages/${string}`;
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
content?: null | string;
embeds?: null | {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | string;
title?: null | string;
url?: null | string;
}[];
};
parts: 4;
path: "-/channels/{target}/messages/{msg}";
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
analytics?: null | boolean;
banner?: null | string;
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
description?: null | string;
discoverable?: null | boolean;
flags?: null | number;
icon?: null | string;
name?: null | string;
remove?: null | (
| "Description"
| "Icon"
| "Categories"
| "SystemMessages"
| "Banner")[];
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
parts: 2;
path: `/servers/${string}`;
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
analytics?: null | boolean;
banner?: null | string;
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
description?: null | string;
discoverable?: null | boolean;
flags?: null | number;
icon?: null | string;
name?: null | string;
remove?: null | (
| "Description"
| "Icon"
| "Categories"
| "SystemMessages"
| "Banner")[];
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
parts: 2;
path: "-/servers/{target}";
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
avatar?: null | string;
nickname?: null | string;
remove?: null | (
| "Nickname"
| "Avatar"
| "Roles"
| "Timeout")[];
roles?: null | string[];
timeout?: null | string;
};
parts: 4;
path: `/servers/${string}/members/${string}`;
response: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
avatar?: null | string;
nickname?: null | string;
remove?: null | (
| "Nickname"
| "Avatar"
| "Roles"
| "Timeout")[];
roles?: null | string[];
timeout?: null | string;
};
parts: 4;
path: "-/servers/{server}/members/{target}";
response: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
colour?: null | string;
hoist?: null | boolean;
name?: null | string;
rank?: null | number;
remove?: null | "Colour"[];
};
parts: 4;
path: `/servers/${string}/roles/${string}`;
response: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
colour?: null | string;
hoist?: null | boolean;
name?: null | string;
rank?: null | number;
remove?: null | "Colour"[];
};
parts: 4;
path: "-/servers/{target}/roles/{role_id}";
response: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
current_password: string;
password: string;
};
parts: 4;
path: "/auth/account/change/password";
response: undefined;
} & {
method: "patch";
}
| {
method: "patch";
params: {
current_password: string;
email: string;
};
parts: 4;
path: "/auth/account/change/email";
response: undefined;
} & {
method: "patch";
}
| never
| never
| never
| {
method: "patch";
params: {
password: string;
remove_sessions?: boolean;
token: string;
};
parts: 3;
path: "/auth/account/reset_password";
response: undefined;
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
friendly_name: string;
};
parts: 3;
path: `/auth/session/${string}`;
response: {
_id: string;
name: string;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
friendly_name: string;
};
parts: 3;
path: "-/auth/session/{id}";
response: {
_id: string;
name: string;
};
} & {
method: "patch";
}
| never
| never
| never
| {
method: "patch";
params: undefined;
parts: 3;
path: "/auth/mfa/recovery";
response: string[];
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never) & {
parts: Count<Path, "/", []>;
path: Path;
}
Parameters
- path: Path
- params: Route["params"]
Optionalconfig: AxiosRequestConfig<any>
Returns Promise<Route["response"]>
Typed Response Data
- patch<Path, Route>(path): Promise<Route["response"]>
Type Parameters
- Path extends "/auth/mfa/recovery"
- Route extends (
| never
| never
| never
| never
| {
method: "patch";
params: {
avatar?: null | string;
badges?: null | number;
display_name?: null | string;
flags?: null | number;
profile?: null | {
background?: null | string;
content?: null | string;
};
remove?: null | (
| "Avatar"
| "StatusText"
| "StatusPresence"
| "ProfileContent"
| "ProfileBackground")[];
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
};
parts: 2;
path: `/users/${string}`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
avatar?: null | string;
badges?: null | number;
display_name?: null | string;
flags?: null | number;
profile?: null | {
background?: null | string;
content?: null | string;
};
remove?: null | (
| "Avatar"
| "StatusText"
| "StatusPresence"
| "ProfileContent"
| "ProfileBackground")[];
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
};
parts: 2;
path: "-/users/{target}";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "patch";
}
| never
| never
| {
method: "patch";
params: {
password: string;
username: string;
};
parts: 3;
path: "/users/@me/username";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
analytics?: null | boolean;
interactions_url?: null | string;
name?: null | string;
public?: null | boolean;
remove?: null | ("Token" | "InteractionsURL")[];
};
parts: 2;
path: `/bots/${string}`;
response: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
analytics?: null | boolean;
interactions_url?: null | string;
name?: null | string;
public?: null | boolean;
remove?: null | ("Token" | "InteractionsURL")[];
};
parts: 2;
path: "-/bots/{target}";
response: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
archived?: null | boolean;
description?: null | string;
icon?: null | string;
name?: null | string;
nsfw?: null | boolean;
owner?: null | string;
remove?: null | ("Description" | "Icon" | "DefaultPermissions")[];
};
parts: 2;
path: `/channels/${string}`;
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
archived?: null | boolean;
description?: null | string;
icon?: null | string;
name?: null | string;
nsfw?: null | boolean;
owner?: null | string;
remove?: null | ("Description" | "Icon" | "DefaultPermissions")[];
};
parts: 2;
path: "-/channels/{target}";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
content?: null | string;
embeds?: null | {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | string;
title?: null | string;
url?: null | string;
}[];
};
parts: 4;
path: `/channels/${string}/messages/${string}`;
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
content?: null | string;
embeds?: null | {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | string;
title?: null | string;
url?: null | string;
}[];
};
parts: 4;
path: "-/channels/{target}/messages/{msg}";
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
analytics?: null | boolean;
banner?: null | string;
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
description?: null | string;
discoverable?: null | boolean;
flags?: null | number;
icon?: null | string;
name?: null | string;
remove?: null | (
| "Description"
| "Icon"
| "Categories"
| "SystemMessages"
| "Banner")[];
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
parts: 2;
path: `/servers/${string}`;
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
analytics?: null | boolean;
banner?: null | string;
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
description?: null | string;
discoverable?: null | boolean;
flags?: null | number;
icon?: null | string;
name?: null | string;
remove?: null | (
| "Description"
| "Icon"
| "Categories"
| "SystemMessages"
| "Banner")[];
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
parts: 2;
path: "-/servers/{target}";
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
avatar?: null | string;
nickname?: null | string;
remove?: null | (
| "Nickname"
| "Avatar"
| "Roles"
| "Timeout")[];
roles?: null | string[];
timeout?: null | string;
};
parts: 4;
path: `/servers/${string}/members/${string}`;
response: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
avatar?: null | string;
nickname?: null | string;
remove?: null | (
| "Nickname"
| "Avatar"
| "Roles"
| "Timeout")[];
roles?: null | string[];
timeout?: null | string;
};
parts: 4;
path: "-/servers/{server}/members/{target}";
response: {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
joined_at: string;
nickname?: null | string;
roles?: string[];
timeout?: null | string;
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
colour?: null | string;
hoist?: null | boolean;
name?: null | string;
rank?: null | number;
remove?: null | "Colour"[];
};
parts: 4;
path: `/servers/${string}/roles/${string}`;
response: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
colour?: null | string;
hoist?: null | boolean;
name?: null | string;
rank?: null | number;
remove?: null | "Colour"[];
};
parts: 4;
path: "-/servers/{target}/roles/{role_id}";
response: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
current_password: string;
password: string;
};
parts: 4;
path: "/auth/account/change/password";
response: undefined;
} & {
method: "patch";
}
| {
method: "patch";
params: {
current_password: string;
email: string;
};
parts: 4;
path: "/auth/account/change/email";
response: undefined;
} & {
method: "patch";
}
| never
| never
| never
| {
method: "patch";
params: {
password: string;
remove_sessions?: boolean;
token: string;
};
parts: 3;
path: "/auth/account/reset_password";
response: undefined;
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| {
method: "patch";
params: {
friendly_name: string;
};
parts: 3;
path: `/auth/session/${string}`;
response: {
_id: string;
name: string;
};
} & {
method: "patch";
}
| {
method: "patch";
params: {
friendly_name: string;
};
parts: 3;
path: "-/auth/session/{id}";
response: {
_id: string;
name: string;
};
} & {
method: "patch";
}
| never
| never
| never
| {
method: "patch";
params: undefined;
parts: 3;
path: "/auth/mfa/recovery";
response: string[];
} & {
method: "patch";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never) & {
parts: Count<Path, "/", []>;
path: Path;
}
Returns Promise<Route["response"]>
Typed Response Data
post
- post<Path, Route>(path, params, config?): Promise<Route["response"]>
Type Parameters
- Path extends
| "/users/friend"
| "/bots/create"
| "/channels/create"
| "/servers/create"
| "/safety/report"
| "/auth/account/create"
| "/auth/account/reverify"
| "/auth/account/delete"
| "/auth/account/reset_password"
| "/auth/session/login"
| "/auth/mfa/totp"
| "/onboard/complete"
| "/push/subscribe"
| "/sync/settings/fetch"
| "/sync/settings/set"
| `/bots/${string}/invite`
| "-/bots/{target}/invite"
| `/channels/${string}/webhooks`
| `/invites/${string}`
| "-/invites/{target}"
| `/channels/${string}/invites`
| "-/channels/{target}/invites"
| `/channels/${string}/messages`
| "-/channels/{target}/messages"
| `/channels/${string}/search`
| "-/channels/{target}/search"
| `/channels/${string}/join_call`
| "-/channels/{target}/join_call"
| "-/channels/{target}/webhooks"
| `/servers/${string}/channels`
| "-/servers/{server}/channels"
| `/servers/${string}/roles`
| "-/servers/{target}/roles"
| "/auth/account/disable"
| `/auth/account/verify/${string}`
| "-/auth/account/verify/{code}"
| "/auth/session/logout"
| "/auth/mfa/recovery"
| "/push/unsubscribe" - Route extends (
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
username: string;
};
parts: 2;
path: "/users/friend";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "post";
}
| {
method: "post";
params: {
name: string;
};
parts: 2;
path: "/bots/create";
response: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
};
} & {
method: "post";
}
| never
| never
| {
method: "post";
params: {
server: string;
} | {
group: string;
};
parts: 3;
path: `/bots/${string}/invite`;
response: undefined;
} & {
method: "post";
}
| {
method: "post";
params: {
server: string;
} | {
group: string;
};
parts: 3;
path: "-/bots/{target}/invite";
response: undefined;
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: undefined;
parts: 3;
path: `/channels/${string}/invites`;
response: {
_id: string;
channel: string;
creator: string;
server: string;
type: "Server";
} | {
_id: string;
channel: string;
creator: string;
type: "Group";
};
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 3;
path: "-/channels/{target}/invites";
response: {
_id: string;
channel: string;
creator: string;
server: string;
type: "Server";
} | {
_id: string;
channel: string;
creator: string;
type: "Group";
};
} & {
method: "post";
}
| never
| never
| {
method: "post";
params: {
attachments?: null | string[];
content?: null | string;
embeds?: null | {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | string;
title?: null | string;
url?: null | string;
}[];
interactions?: null | {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
nonce?: null | string;
replies?: null | {
id: string;
mention: boolean;
}[];
};
parts: 3;
path: `/channels/${string}/messages`;
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "post";
}
| {
method: "post";
params: {
attachments?: null | string[];
content?: null | string;
embeds?: null | {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | string;
title?: null | string;
url?: null | string;
}[];
interactions?: null | {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
nonce?: null | string;
replies?: null | {
id: string;
mention: boolean;
}[];
};
parts: 3;
path: "-/channels/{target}/messages";
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "post";
}
| {
method: "post";
params: {
after?: null | string;
before?: null | string;
include_users?: null | boolean;
limit?: null | number;
query: string;
sort?: "Relevance" | "Latest" | "Oldest";
};
parts: 3;
path: `/channels/${string}/search`;
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: ...;
description?: ...;
icon_url?: ...;
image?: ...;
original_url?: ...;
site_name?: ...;
special?: ...;
title?: ...;
type: ...;
url?: ...;
video?: ...;
}
| {
height: ...;
size: ...;
type: ...;
url: ...;
width: ...;
}
| {
height: ...;
type: ...;
url: ...;
width: ...;
}
| {
colour?: ...;
description?: ...;
icon_url?: ...;
media?: ...;
title?: ...;
type: ...;
url?: ...;
}
| {
type: ...;
})[];
interactions?: {
reactions?: null | (...)[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
}[] | {
members?: null | {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
joined_at: string;
nickname?: null | string;
roles?: (...)[];
timeout?: null | string;
}[];
messages: {
_id: string;
attachments?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| (...)
| (...)
| (...)
| (...)
| (...))[];
interactions?: {
reactions?: (...) | (...) | (...);
restrict_reactions?: (...) | (...) | (...);
};
masquerade?: null | {
avatar?: (...) | (...) | (...);
colour?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: (...)[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: (...) | (...) | (...);
name: string;
};
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "post";
}
| {
method: "post";
params: {
after?: null | string;
before?: null | string;
include_users?: null | boolean;
limit?: null | number;
query: string;
sort?: "Relevance" | "Latest" | "Oldest";
};
parts: 3;
path: "-/channels/{target}/search";
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: ...;
description?: ...;
icon_url?: ...;
image?: ...;
original_url?: ...;
site_name?: ...;
special?: ...;
title?: ...;
type: ...;
url?: ...;
video?: ...;
}
| {
height: ...;
size: ...;
type: ...;
url: ...;
width: ...;
}
| {
height: ...;
type: ...;
url: ...;
width: ...;
}
| {
colour?: ...;
description?: ...;
icon_url?: ...;
media?: ...;
title?: ...;
type: ...;
url?: ...;
}
| {
type: ...;
})[];
interactions?: {
reactions?: null | (...)[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
}[] | {
members?: null | {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
joined_at: string;
nickname?: null | string;
roles?: (...)[];
timeout?: null | string;
}[];
messages: {
_id: string;
attachments?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| (...)
| (...)
| (...)
| (...)
| (...))[];
interactions?: {
reactions?: (...) | (...) | (...);
restrict_reactions?: (...) | (...) | (...);
};
masquerade?: null | {
avatar?: (...) | (...) | (...);
colour?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: (...)[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: (...) | (...) | (...);
name: string;
};
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
description?: null | string;
icon?: null | string;
name: string;
nsfw?: null | boolean;
users?: string[];
};
parts: 2;
path: "/channels/create";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "post";
}
| never
| never
| never
| never
| {
method: "post";
params: undefined;
parts: 3;
path: `/channels/${string}/join_call`;
response: {
token: string;
};
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 3;
path: "-/channels/{target}/join_call";
response: {
token: string;
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
avatar?: null | string;
name: string;
};
parts: 3;
path: `/channels/${string}/webhooks`;
response: {
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
channel_id: string;
id: string;
name: string;
permissions: number;
token?: null | string;
};
} & {
method: "post";
}
| {
method: "post";
params: {
avatar?: null | string;
name: string;
};
parts: 3;
path: "-/channels/{target}/webhooks";
response: {
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
channel_id: string;
id: string;
name: string;
permissions: number;
token?: null | string;
};
} & {
method: "post";
}
| never
| never
| {
method: "post";
params: {
description?: null | string;
name: string;
nsfw?: null | boolean;
};
parts: 2;
path: "/servers/create";
response: {
channels: (
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
})[];
server: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
description?: null | string;
name: string;
nsfw?: null | boolean;
type?: "Text" | "Voice";
};
parts: 3;
path: `/servers/${string}/channels`;
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "post";
}
| {
method: "post";
params: {
description?: null | string;
name: string;
nsfw?: null | boolean;
type?: "Text" | "Voice";
};
parts: 3;
path: "-/servers/{server}/channels";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
name: string;
rank?: null | number;
};
parts: 3;
path: `/servers/${string}/roles`;
response: {
id: string;
role: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
};
} & {
method: "post";
}
| {
method: "post";
params: {
name: string;
rank?: null | number;
};
parts: 3;
path: "-/servers/{target}/roles";
response: {
id: string;
role: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: undefined;
parts: 2;
path: `/invites/${string}`;
response: {
channels: (
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: ...;
d: ...;
};
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: ...]: ...;
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: ...;
d: ...;
};
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: ...]: ...;
};
server: string;
})[];
server: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: (...)[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: (...)[(...)]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
type: "Server";
} | {
channel:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
};
type: "Group";
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 2;
path: "-/invites/{target}";
response: {
channels: (
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: ...;
d: ...;
};
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: ...]: ...;
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: ...;
d: ...;
};
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: ...]: ...;
};
server: string;
})[];
server: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: (...)[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: (...)[(...)]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
type: "Server";
} | {
channel:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
};
type: "Group";
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
additional_context?: string;
content: {
id: string;
report_reason:
| "NoneSpecified"
| "Illegal"
| "IllegalGoods"
| "IllegalExtortion"
| "IllegalPornography"
| "IllegalHacking"
| "ExtremeViolence"
| "PromotesHarm"
| "UnsolicitedSpam"
| "Raid"
| "SpamAbuse"
| "ScamsFraud"
| "Malware"
| "Harassment";
type: "Message";
} | {
id: string;
report_reason:
| "NoneSpecified"
| "Illegal"
| "IllegalGoods"
| "IllegalExtortion"
| "IllegalPornography"
| "IllegalHacking"
| "ExtremeViolence"
| "PromotesHarm"
| "UnsolicitedSpam"
| "Raid"
| "SpamAbuse"
| "ScamsFraud"
| "Malware"
| "Harassment";
type: "Server";
} | {
id: string;
message_id?: null | string;
report_reason:
| "NoneSpecified"
| "UnsolicitedSpam"
| "SpamAbuse"
| "InappropriateProfile"
| "Impersonation"
| "BanEvasion"
| "Underage";
type: "User";
};
};
parts: 2;
path: "/safety/report";
response: undefined;
} & {
method: "post";
}
| {
method: "post";
params: {
captcha?: null | string;
email: string;
invite?: null | string;
password: string;
};
parts: 3;
path: "/auth/account/create";
response: undefined;
} & {
method: "post";
}
| {
method: "post";
params: {
captcha?: null | string;
email: string;
};
parts: 3;
path: "/auth/account/reverify";
response: undefined;
} & {
method: "post";
}
| never
| {
method: "post";
params: undefined;
parts: 3;
path: "/auth/account/delete";
response: undefined;
} & {
method: "post";
}
| never
| {
method: "post";
params: undefined;
parts: 3;
path: "/auth/account/disable";
response: undefined;
} & {
method: "post";
}
| never
| never
| {
method: "post";
params: undefined;
parts: 4;
path: `/auth/account/verify/${string}`;
response: unknown;
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 4;
path: "-/auth/account/verify/{code}";
response: unknown;
} & {
method: "post";
}
| {
method: "post";
params: {
captcha?: null | string;
email: string;
};
parts: 3;
path: "/auth/account/reset_password";
response: undefined;
} & {
method: "post";
}
| never
| {
method: "post";
params: {
email: string;
friendly_name?: null | string;
password: string;
} | {
friendly_name?: null | string;
mfa_response?:
| null
| {
password: string;
}
| {
recovery_code: string;
}
| {
totp_code: string;
};
mfa_ticket: string;
};
parts: 3;
path: "/auth/session/login";
response: {
_id: string;
name: string;
result: "Success";
subscription?: null | {
auth: string;
endpoint: string;
p256dh: string;
};
token: string;
user_id: string;
} | {
allowed_methods: ("Password" | "Recovery" | "Totp")[];
result: "MFA";
ticket: string;
} | {
result: "Disabled";
user_id: string;
};
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 3;
path: "/auth/session/logout";
response: undefined;
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: undefined;
parts: 3;
path: "/auth/mfa/recovery";
response: string[];
} & {
method: "post";
}
| never
| never
| never
| {
method: "post";
params: undefined;
parts: 3;
path: "/auth/mfa/totp";
response: {
secret: string;
};
} & {
method: "post";
}
| never
| never
| {
method: "post";
params: {
username: string;
};
parts: 2;
path: "/onboard/complete";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "post";
}
| {
method: "post";
params: {
auth: string;
endpoint: string;
p256dh: string;
};
parts: 2;
path: "/push/subscribe";
response: undefined;
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 2;
path: "/push/unsubscribe";
response: undefined;
} & {
method: "post";
}
| {
method: "post";
params: {
keys: string[];
};
parts: 3;
path: "/sync/settings/fetch";
response: {
[key: string]: [number, string];
};
} & {
method: "post";
}
| {
method: "post";
params: {
timestamp?: null | number;
} | {
[key: string]: string;
};
parts: 3;
path: "/sync/settings/set";
response: undefined;
} & {
method: "post";
}
| never) & {
parts: Count<Path, "/", []>;
path: Path;
}
Parameters
- path: Path
- params: Route["params"]
Optionalconfig: AxiosRequestConfig<any>
Returns Promise<Route["response"]>
Typed Response Data
- post<Path, Route>(path): Promise<Route["response"]>
Type Parameters
- Path extends
| "/auth/account/delete"
| "/auth/mfa/totp"
| `/invites/${string}`
| "-/invites/{target}"
| `/channels/${string}/invites`
| "-/channels/{target}/invites"
| `/channels/${string}/join_call`
| "-/channels/{target}/join_call"
| "/auth/account/disable"
| `/auth/account/verify/${string}`
| "-/auth/account/verify/{code}"
| "/auth/session/logout"
| "/auth/mfa/recovery"
| "/push/unsubscribe" - Route extends (
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
username: string;
};
parts: 2;
path: "/users/friend";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "post";
}
| {
method: "post";
params: {
name: string;
};
parts: 2;
path: "/bots/create";
response: {
_id: string;
analytics?: boolean;
discoverable?: boolean;
flags?: number;
interactions_url?: string;
owner: string;
privacy_policy_url?: string;
public: boolean;
terms_of_service_url?: string;
token: string;
};
} & {
method: "post";
}
| never
| never
| {
method: "post";
params: {
server: string;
} | {
group: string;
};
parts: 3;
path: `/bots/${string}/invite`;
response: undefined;
} & {
method: "post";
}
| {
method: "post";
params: {
server: string;
} | {
group: string;
};
parts: 3;
path: "-/bots/{target}/invite";
response: undefined;
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: undefined;
parts: 3;
path: `/channels/${string}/invites`;
response: {
_id: string;
channel: string;
creator: string;
server: string;
type: "Server";
} | {
_id: string;
channel: string;
creator: string;
type: "Group";
};
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 3;
path: "-/channels/{target}/invites";
response: {
_id: string;
channel: string;
creator: string;
server: string;
type: "Server";
} | {
_id: string;
channel: string;
creator: string;
type: "Group";
};
} & {
method: "post";
}
| never
| never
| {
method: "post";
params: {
attachments?: null | string[];
content?: null | string;
embeds?: null | {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | string;
title?: null | string;
url?: null | string;
}[];
interactions?: null | {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
nonce?: null | string;
replies?: null | {
id: string;
mention: boolean;
}[];
};
parts: 3;
path: `/channels/${string}/messages`;
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "post";
}
| {
method: "post";
params: {
attachments?: null | string[];
content?: null | string;
embeds?: null | {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | string;
title?: null | string;
url?: null | string;
}[];
interactions?: null | {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
nonce?: null | string;
replies?: null | {
id: string;
mention: boolean;
}[];
};
parts: 3;
path: "-/channels/{target}/messages";
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
image?: null | {
height: ...;
size: ...;
url: ...;
width: ...;
};
original_url?: null | string;
site_name?: null | string;
special?:
| null
| {
type: ...;
}
| {
type: ...;
}
| {
id: ...;
timestamp?: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
type: ...;
}
| {
content_type: ...;
id: ...;
type: ...;
}
| {
id: ...;
type: ...;
};
title?: null | string;
type: "Website";
url?: null | string;
video?: null | {
height: ...;
url: ...;
width: ...;
};
}
| {
height: number;
size: "Large" | "Preview";
type: "Image";
url: string;
width: number;
}
| {
height: number;
type: "Video";
url: string;
width: number;
}
| {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
title?: null | string;
type: "Text";
url?: null | string;
}
| {
type: "None";
})[];
interactions?: {
reactions?: null | string[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
};
} & {
method: "post";
}
| {
method: "post";
params: {
after?: null | string;
before?: null | string;
include_users?: null | boolean;
limit?: null | number;
query: string;
sort?: "Relevance" | "Latest" | "Oldest";
};
parts: 3;
path: `/channels/${string}/search`;
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: ...;
description?: ...;
icon_url?: ...;
image?: ...;
original_url?: ...;
site_name?: ...;
special?: ...;
title?: ...;
type: ...;
url?: ...;
video?: ...;
}
| {
height: ...;
size: ...;
type: ...;
url: ...;
width: ...;
}
| {
height: ...;
type: ...;
url: ...;
width: ...;
}
| {
colour?: ...;
description?: ...;
icon_url?: ...;
media?: ...;
title?: ...;
type: ...;
url?: ...;
}
| {
type: ...;
})[];
interactions?: {
reactions?: null | (...)[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
}[] | {
members?: null | {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
joined_at: string;
nickname?: null | string;
roles?: (...)[];
timeout?: null | string;
}[];
messages: {
_id: string;
attachments?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| (...)
| (...)
| (...)
| (...)
| (...))[];
interactions?: {
reactions?: (...) | (...) | (...);
restrict_reactions?: (...) | (...) | (...);
};
masquerade?: null | {
avatar?: (...) | (...) | (...);
colour?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: (...)[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: (...) | (...) | (...);
name: string;
};
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "post";
}
| {
method: "post";
params: {
after?: null | string;
before?: null | string;
include_users?: null | boolean;
limit?: null | number;
query: string;
sort?: "Relevance" | "Latest" | "Oldest";
};
parts: 3;
path: "-/channels/{target}/search";
response: {
_id: string;
attachments?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| {
colour?: ...;
description?: ...;
icon_url?: ...;
image?: ...;
original_url?: ...;
site_name?: ...;
special?: ...;
title?: ...;
type: ...;
url?: ...;
video?: ...;
}
| {
height: ...;
size: ...;
type: ...;
url: ...;
width: ...;
}
| {
height: ...;
type: ...;
url: ...;
width: ...;
}
| {
colour?: ...;
description?: ...;
icon_url?: ...;
media?: ...;
title?: ...;
type: ...;
url?: ...;
}
| {
type: ...;
})[];
interactions?: {
reactions?: null | (...)[];
restrict_reactions?: boolean;
};
masquerade?: null | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: string[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: null | string;
name: string;
};
}[] | {
members?: null | {
_id: {
server: string;
user: string;
};
avatar?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
joined_at: string;
nickname?: null | string;
roles?: (...)[];
timeout?: null | string;
}[];
messages: {
_id: string;
attachments?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
}[];
author: string;
channel: string;
content?: null | string;
edited?: null | string;
embeds?: null | (
| (...)
| (...)
| (...)
| (...)
| (...))[];
interactions?: {
reactions?: (...) | (...) | (...);
restrict_reactions?: (...) | (...) | (...);
};
masquerade?: null | {
avatar?: (...) | (...) | (...);
colour?: (...) | (...) | (...);
name?: (...) | (...) | (...);
};
mentions?: null | string[];
nonce?: null | string;
reactions?: {
[key: string]: (...)[];
};
replies?: null | string[];
system?:
| null
| {
content: string;
type: "text";
}
| {
by: string;
id: string;
type: "user_added";
}
| {
by: string;
id: string;
type: "user_remove";
}
| {
id: string;
type: "user_joined";
}
| {
id: string;
type: "user_left";
}
| {
id: string;
type: "user_kicked";
}
| {
id: string;
type: "user_banned";
}
| {
by: string;
name: string;
type: "channel_renamed";
}
| {
by: string;
type: "channel_description_changed";
}
| {
by: string;
type: "channel_icon_changed";
}
| {
from: string;
to: string;
type: "channel_ownership_changed";
};
webhook?: null | {
avatar?: (...) | (...) | (...);
name: string;
};
}[];
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
description?: null | string;
icon?: null | string;
name: string;
nsfw?: null | boolean;
users?: string[];
};
parts: 2;
path: "/channels/create";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "post";
}
| never
| never
| never
| never
| {
method: "post";
params: undefined;
parts: 3;
path: `/channels/${string}/join_call`;
response: {
token: string;
};
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 3;
path: "-/channels/{target}/join_call";
response: {
token: string;
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
avatar?: null | string;
name: string;
};
parts: 3;
path: `/channels/${string}/webhooks`;
response: {
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
channel_id: string;
id: string;
name: string;
permissions: number;
token?: null | string;
};
} & {
method: "post";
}
| {
method: "post";
params: {
avatar?: null | string;
name: string;
};
parts: 3;
path: "-/channels/{target}/webhooks";
response: {
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
channel_id: string;
id: string;
name: string;
permissions: number;
token?: null | string;
};
} & {
method: "post";
}
| never
| never
| {
method: "post";
params: {
description?: null | string;
name: string;
nsfw?: null | boolean;
};
parts: 2;
path: "/servers/create";
response: {
channels: (
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
})[];
server: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
description?: null | string;
name: string;
nsfw?: null | boolean;
type?: "Text" | "Voice";
};
parts: 3;
path: `/servers/${string}/channels`;
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "post";
}
| {
method: "post";
params: {
description?: null | string;
name: string;
nsfw?: null | boolean;
type?: "Text" | "Voice";
};
parts: 3;
path: "-/servers/{server}/channels";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
name: string;
rank?: null | number;
};
parts: 3;
path: `/servers/${string}/roles`;
response: {
id: string;
role: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
};
} & {
method: "post";
}
| {
method: "post";
params: {
name: string;
rank?: null | number;
};
parts: 3;
path: "-/servers/{target}/roles";
response: {
id: string;
role: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: {
a: number;
d: number;
};
rank?: number;
};
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: undefined;
parts: 2;
path: `/invites/${string}`;
response: {
channels: (
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: ...;
d: ...;
};
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: ...]: ...;
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: ...;
d: ...;
};
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: ...]: ...;
};
server: string;
})[];
server: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: (...)[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: (...)[(...)]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
type: "Server";
} | {
channel:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
};
type: "Group";
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 2;
path: "-/invites/{target}";
response: {
channels: (
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: ...;
d: ...;
};
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: ...]: ...;
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: ...;
d: ...;
};
description?: null | string;
icon?: null | {
_id: ...;
content_type: ...;
deleted?: ...;
filename: ...;
message_id?: ...;
metadata: ...;
object_id?: ...;
reported?: ...;
server_id?: ...;
size: ...;
tag: ...;
user_id?: ...;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: ...]: ...;
};
server: string;
})[];
server: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: (...)[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: ...;
}
| {
type: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
height: ...;
type: ...;
width: ...;
}
| {
type: ...;
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: (...)[(...)]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
type: "Server";
} | {
channel:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: (...)[(...)];
};
server: string;
};
type: "Group";
users: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?:
| (...)
| (...)
| (...)
| (...);
filename: string;
message_id?: (...) | (...) | (...);
metadata:
| (...)
| (...)
| (...)
| (...)
| (...);
object_id?: (...) | (...) | (...);
reported?:
| (...)
| (...)
| (...)
| (...);
server_id?: (...) | (...) | (...);
size: number;
tag: string;
user_id?: (...) | (...) | (...);
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: ...;
status: ...;
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
text?: (...) | (...) | (...);
};
username: string;
}[];
};
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: {
additional_context?: string;
content: {
id: string;
report_reason:
| "NoneSpecified"
| "Illegal"
| "IllegalGoods"
| "IllegalExtortion"
| "IllegalPornography"
| "IllegalHacking"
| "ExtremeViolence"
| "PromotesHarm"
| "UnsolicitedSpam"
| "Raid"
| "SpamAbuse"
| "ScamsFraud"
| "Malware"
| "Harassment";
type: "Message";
} | {
id: string;
report_reason:
| "NoneSpecified"
| "Illegal"
| "IllegalGoods"
| "IllegalExtortion"
| "IllegalPornography"
| "IllegalHacking"
| "ExtremeViolence"
| "PromotesHarm"
| "UnsolicitedSpam"
| "Raid"
| "SpamAbuse"
| "ScamsFraud"
| "Malware"
| "Harassment";
type: "Server";
} | {
id: string;
message_id?: null | string;
report_reason:
| "NoneSpecified"
| "UnsolicitedSpam"
| "SpamAbuse"
| "InappropriateProfile"
| "Impersonation"
| "BanEvasion"
| "Underage";
type: "User";
};
};
parts: 2;
path: "/safety/report";
response: undefined;
} & {
method: "post";
}
| {
method: "post";
params: {
captcha?: null | string;
email: string;
invite?: null | string;
password: string;
};
parts: 3;
path: "/auth/account/create";
response: undefined;
} & {
method: "post";
}
| {
method: "post";
params: {
captcha?: null | string;
email: string;
};
parts: 3;
path: "/auth/account/reverify";
response: undefined;
} & {
method: "post";
}
| never
| {
method: "post";
params: undefined;
parts: 3;
path: "/auth/account/delete";
response: undefined;
} & {
method: "post";
}
| never
| {
method: "post";
params: undefined;
parts: 3;
path: "/auth/account/disable";
response: undefined;
} & {
method: "post";
}
| never
| never
| {
method: "post";
params: undefined;
parts: 4;
path: `/auth/account/verify/${string}`;
response: unknown;
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 4;
path: "-/auth/account/verify/{code}";
response: unknown;
} & {
method: "post";
}
| {
method: "post";
params: {
captcha?: null | string;
email: string;
};
parts: 3;
path: "/auth/account/reset_password";
response: undefined;
} & {
method: "post";
}
| never
| {
method: "post";
params: {
email: string;
friendly_name?: null | string;
password: string;
} | {
friendly_name?: null | string;
mfa_response?:
| null
| {
password: string;
}
| {
recovery_code: string;
}
| {
totp_code: string;
};
mfa_ticket: string;
};
parts: 3;
path: "/auth/session/login";
response: {
_id: string;
name: string;
result: "Success";
subscription?: null | {
auth: string;
endpoint: string;
p256dh: string;
};
token: string;
user_id: string;
} | {
allowed_methods: ("Password" | "Recovery" | "Totp")[];
result: "MFA";
ticket: string;
} | {
result: "Disabled";
user_id: string;
};
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 3;
path: "/auth/session/logout";
response: undefined;
} & {
method: "post";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "post";
params: undefined;
parts: 3;
path: "/auth/mfa/recovery";
response: string[];
} & {
method: "post";
}
| never
| never
| never
| {
method: "post";
params: undefined;
parts: 3;
path: "/auth/mfa/totp";
response: {
secret: string;
};
} & {
method: "post";
}
| never
| never
| {
method: "post";
params: {
username: string;
};
parts: 2;
path: "/onboard/complete";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "post";
}
| {
method: "post";
params: {
auth: string;
endpoint: string;
p256dh: string;
};
parts: 2;
path: "/push/subscribe";
response: undefined;
} & {
method: "post";
}
| {
method: "post";
params: undefined;
parts: 2;
path: "/push/unsubscribe";
response: undefined;
} & {
method: "post";
}
| {
method: "post";
params: {
keys: string[];
};
parts: 3;
path: "/sync/settings/fetch";
response: {
[key: string]: [number, string];
};
} & {
method: "post";
}
| {
method: "post";
params: {
timestamp?: null | number;
} | {
[key: string]: string;
};
parts: 3;
path: "/sync/settings/set";
response: undefined;
} & {
method: "post";
}
| never) & {
parts: Count<Path, "/", []>;
path: Path;
}
Returns Promise<Route["response"]>
Typed Response Data
put
- put<Path, Route>(path, params, config?): Promise<Route["response"]>
Type Parameters
- Path extends
| "/auth/account/delete"
| "/auth/mfa/ticket"
| "/auth/mfa/totp"
| `/custom/emoji/${string}`
| `/users/${string}/friend`
| "-/users/{target}/friend"
| `/users/${string}/block`
| "-/users/{target}/block"
| `/channels/${string}/ack/${string}`
| "-/channels/{target}/ack/{message}"
| `/channels/${string}/recipients/${string}`
| "-/channels/{group_id}/recipients/{member_id}"
| `/channels/${string}/permissions/${string}`
| "-/channels/{target}/permissions/{role_id}"
| `/channels/${string}/permissions/default`
| "-/channels/{target}/permissions/default"
| `/channels/${string}/messages/${string}/reactions/${string}`
| "-/channels/{target}/messages/{msg}/reactions/{emoji}"
| `/servers/${string}/ack`
| "-/servers/{target}/ack"
| `/servers/${string}/bans/${string}`
| "-/servers/{server}/bans/{target}"
| `/servers/${string}/permissions/${string}`
| "-/servers/{target}/permissions/{role_id}"
| `/servers/${string}/permissions/default`
| "-/servers/{target}/permissions/default"
| "-/custom/emoji/{id}" - Route extends (
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: undefined;
parts: 3;
path: `/users/${string}/friend`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 3;
path: "-/users/{target}/friend";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "put";
}
| never
| never
| {
method: "put";
params: undefined;
parts: 3;
path: `/users/${string}/block`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 3;
path: "-/users/{target}/block";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: undefined;
parts: 4;
path: `/channels/${string}/ack/${string}`;
response: undefined;
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 4;
path: "-/channels/{target}/ack/{message}";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: undefined;
parts: 4;
path: `/channels/${string}/recipients/${string}`;
response: undefined;
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 4;
path: "-/channels/{group_id}/recipients/{member_id}";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| {
method: "put";
params: {
permissions: {
allow: number;
deny: number;
};
};
parts: 4;
path: `/channels/${string}/permissions/${string}`;
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: {
allow: number;
deny: number;
};
};
parts: 4;
path: "-/channels/{target}/permissions/{role_id}";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: number;
};
parts: 4;
path: `/channels/${string}/permissions/default`;
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: number;
};
parts: 4;
path: "-/channels/{target}/permissions/default";
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 6;
path: `/channels/${string}/messages/${string}/reactions/${string}`;
response: undefined;
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 6;
path: "-/channels/{target}/messages/{msg}/reactions/{emoji}";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: undefined;
parts: 3;
path: `/servers/${string}/ack`;
response: undefined;
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 3;
path: "-/servers/{target}/ack";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: {
reason?: null | string;
};
parts: 4;
path: `/servers/${string}/bans/${string}`;
response: {
_id: {
server: string;
user: string;
};
reason?: null | string;
};
} & {
method: "put";
}
| {
method: "put";
params: {
reason?: null | string;
};
parts: 4;
path: "-/servers/{server}/bans/{target}";
response: {
_id: {
server: string;
user: string;
};
reason?: null | string;
};
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: {
permissions: {
allow: number;
deny: number;
};
};
parts: 4;
path: `/servers/${string}/permissions/${string}`;
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: {
allow: number;
deny: number;
};
};
parts: 4;
path: "-/servers/{target}/permissions/{role_id}";
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: number;
};
parts: 4;
path: `/servers/${string}/permissions/default`;
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: number;
};
parts: 4;
path: "-/servers/{target}/permissions/default";
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: {
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
parts: 3;
path: `/custom/emoji/${string}`;
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
} & {
method: "put";
}
| {
method: "put";
params: {
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
parts: 3;
path: "-/custom/emoji/{id}";
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: {
token: string;
};
parts: 3;
path: "/auth/account/delete";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: {
password: string;
} | {
recovery_code: string;
} | {
totp_code: string;
};
parts: 3;
path: "/auth/mfa/ticket";
response: {
_id: string;
account_id: string;
authorised: boolean;
last_totp_code?: null | string;
token: string;
validated: boolean;
};
} & {
method: "put";
}
| never
| never
| never
| never
| {
method: "put";
params: {
password: string;
} | {
recovery_code: string;
} | {
totp_code: string;
};
parts: 3;
path: "/auth/mfa/totp";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never) & {
parts: Count<Path, "/", []>;
path: Path;
}
Parameters
- path: Path
- params: Route["params"]
Optionalconfig: AxiosRequestConfig<any>
Returns Promise<Route["response"]>
Typed Response Data
- put<Path, Route>(path): Promise<Route["response"]>
Type Parameters
- Path extends
| `/users/${string}/friend`
| "-/users/{target}/friend"
| `/users/${string}/block`
| "-/users/{target}/block"
| `/channels/${string}/ack/${string}`
| "-/channels/{target}/ack/{message}"
| `/channels/${string}/recipients/${string}`
| "-/channels/{group_id}/recipients/{member_id}"
| `/channels/${string}/messages/${string}/reactions/${string}`
| "-/channels/{target}/messages/{msg}/reactions/{emoji}"
| `/servers/${string}/ack`
| "-/servers/{target}/ack" - Route extends (
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: undefined;
parts: 3;
path: `/users/${string}/friend`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 3;
path: "-/users/{target}/friend";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "put";
}
| never
| never
| {
method: "put";
params: undefined;
parts: 3;
path: `/users/${string}/block`;
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 3;
path: "-/users/{target}/block";
response: {
_id: string;
avatar?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
badges?: number;
bot?: null | {
owner: string;
};
discriminator: string;
display_name?: null | string;
flags?: number;
online: boolean;
privileged?: boolean;
relations?: {
_id: string;
status:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
}[];
relationship:
| "User"
| "None"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
status?: null | {
presence?:
| null
| "Online"
| "Idle"
| "Focus"
| "Busy"
| "Invisible";
text?: null | string;
};
username: string;
};
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: undefined;
parts: 4;
path: `/channels/${string}/ack/${string}`;
response: undefined;
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 4;
path: "-/channels/{target}/ack/{message}";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: undefined;
parts: 4;
path: `/channels/${string}/recipients/${string}`;
response: undefined;
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 4;
path: "-/channels/{group_id}/recipients/{member_id}";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| {
method: "put";
params: {
permissions: {
allow: number;
deny: number;
};
};
parts: 4;
path: `/channels/${string}/permissions/${string}`;
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: {
allow: number;
deny: number;
};
};
parts: 4;
path: "-/channels/{target}/permissions/{role_id}";
response:
| {
_id: string;
channel_type: "SavedMessages";
user: string;
}
| {
_id: string;
active: boolean;
channel_type: "DirectMessage";
last_message_id?: null | string;
recipients: string[];
}
| {
_id: string;
channel_type: "Group";
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
owner: string;
permissions?: null | number;
recipients: string[];
}
| {
_id: string;
channel_type: "TextChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
last_message_id?: null | string;
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
}
| {
_id: string;
channel_type: "VoiceChannel";
default_permissions?: null | {
a: number;
d: number;
};
description?: null | string;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
server: string;
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: number;
};
parts: 4;
path: `/channels/${string}/permissions/default`;
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: number;
};
parts: 4;
path: "-/channels/{target}/permissions/default";
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 6;
path: `/channels/${string}/messages/${string}/reactions/${string}`;
response: undefined;
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 6;
path: "-/channels/{target}/messages/{msg}/reactions/{emoji}";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: undefined;
parts: 3;
path: `/servers/${string}/ack`;
response: undefined;
} & {
method: "put";
}
| {
method: "put";
params: undefined;
parts: 3;
path: "-/servers/{target}/ack";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: {
reason?: null | string;
};
parts: 4;
path: `/servers/${string}/bans/${string}`;
response: {
_id: {
server: string;
user: string;
};
reason?: null | string;
};
} & {
method: "put";
}
| {
method: "put";
params: {
reason?: null | string;
};
parts: 4;
path: "-/servers/{server}/bans/{target}";
response: {
_id: {
server: string;
user: string;
};
reason?: null | string;
};
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: {
permissions: {
allow: number;
deny: number;
};
};
parts: 4;
path: `/servers/${string}/permissions/${string}`;
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: {
allow: number;
deny: number;
};
};
parts: 4;
path: "-/servers/{target}/permissions/{role_id}";
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: number;
};
parts: 4;
path: `/servers/${string}/permissions/default`;
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| {
method: "put";
params: {
permissions: number;
};
parts: 4;
path: "-/servers/{target}/permissions/default";
response: {
_id: string;
analytics?: boolean;
banner?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
categories?: null | {
channels: string[];
id: string;
title: string;
}[];
channels: string[];
default_permissions: number;
description?: null | string;
discoverable?: boolean;
flags?: number;
icon?: null | {
_id: string;
content_type: string;
deleted?: null | boolean;
filename: string;
message_id?: null | string;
metadata:
| {
type: "File";
}
| {
type: "Text";
}
| {
height: number;
type: "Image";
width: number;
}
| {
height: number;
type: "Video";
width: number;
}
| {
type: "Audio";
};
object_id?: null | string;
reported?: null | boolean;
server_id?: null | string;
size: number;
tag: string;
user_id?: null | string;
};
name: string;
nsfw?: boolean;
owner: string;
roles?: {
[key: string]: components["schemas"]["Role"];
};
system_messages?: null | {
user_banned?: null | string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
};
};
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: {
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
parts: 3;
path: `/custom/emoji/${string}`;
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
} & {
method: "put";
}
| {
method: "put";
params: {
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
parts: 3;
path: "-/custom/emoji/{id}";
response: {
_id: string;
animated?: boolean;
creator_id: string;
name: string;
nsfw?: boolean;
parent: {
id: string;
type: "Server";
} | {
type: "Detached";
};
};
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: {
token: string;
};
parts: 3;
path: "/auth/account/delete";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| never
| {
method: "put";
params: {
password: string;
} | {
recovery_code: string;
} | {
totp_code: string;
};
parts: 3;
path: "/auth/mfa/ticket";
response: {
_id: string;
account_id: string;
authorised: boolean;
last_totp_code?: null | string;
token: string;
validated: boolean;
};
} & {
method: "put";
}
| never
| never
| never
| never
| {
method: "put";
params: {
password: string;
} | {
recovery_code: string;
} | {
totp_code: string;
};
parts: 3;
path: "/auth/mfa/totp";
response: undefined;
} & {
method: "put";
}
| never
| never
| never
| never
| never
| never
| never
| never
| never) & {
parts: Count<Path, "/", []>;
path: Path;
}
Returns Promise<Route["response"]>
Typed Response Data
req
- req<Method, Routes, Path, Route>(method, path, params, config?): Promise<Route["response"]>
Type Parameters
- Method extends
| "get"
| "patch"
| "put"
| "delete"
| "post" - Routes extends PickRoutes<Method>
- Path extends
| "/"
| "/safety/report"
| "/auth/account/create"
| "/auth/account/reverify"
| "/auth/account/delete"
| "/auth/account/change/password"
| "/auth/account/change/email"
| "/auth/account/reset_password"
| "/auth/mfa/ticket"
| "/auth/mfa/totp"
| "/onboard/complete"
| "/push/subscribe"
| "/sync/settings/fetch"
| "/sync/settings/set"
| `/users/${string}`
| "-/users/{target}"
| `/users/${string}/flags`
| "-/users/{target}/flags"
| `/users/${string}/default_avatar`
| "-/users/{target}/default_avatar"
| `/users/${string}/profile`
| "-/users/{target}/profile"
| `/users/${string}/dm`
| "-/users/{target}/dm"
| `/users/${string}/mutual`
| "-/users/{target}/mutual"
| `/bots/${string}/invite`
| "-/bots/{target}/invite"
| `/bots/${string}`
| "-/bots/{bot}"
| `/channels/${string}`
| "-/channels/{target}"
| `/channels/${string}/members`
| "-/channels/{target}/members"
| `/channels/${string}/messages/${string}`
| "-/channels/{target}/messages/{msg}"
| `/channels/${string}/webhooks`
| "-/channels/{channel_id}/webhooks"
| `/servers/${string}/bans`
| "-/servers/{target}/bans"
| `/servers/${string}/invites`
| "-/servers/{target}/invites"
| `/servers/${string}/roles/${string}`
| "-/servers/{target}/roles/{role_id}"
| `/servers/${string}/emojis`
| "-/servers/{target}/emojis"
| `/invites/${string}`
| "-/invites/{target}"
| `/custom/emoji/${string}`
| "-/custom/emoji/{emoji_id}"
| "/auth/account/"
| "/auth/mfa/"
| "/auth/mfa/methods"
| "/onboard/hello"
| "/sync/unreads"
| `/users/${string}/friend`
| "-/users/{target}/friend"
| `/users/${string}/block`
| "-/users/{target}/block"
| "-/bots/{target}"
| `/channels/${string}/ack/${string}`
| "-/channels/{target}/ack/{message}"
| `/channels/${string}/invites`
| "-/channels/{target}/invites"
| `/channels/${string}/messages`
| "-/channels/{target}/messages"
| `/channels/${string}/search`
| "-/channels/{target}/search"
| `/channels/${string}/messages/bulk`
| "-/channels/{target}/messages/bulk"
| `/channels/${string}/recipients/${string}`
| "-/channels/{group_id}/recipients/{member_id}"
| "-/channels/{target}/recipients/{member}"
| `/channels/${string}/join_call`
| "-/channels/{target}/join_call"
| `/channels/${string}/permissions/${string}`
| "-/channels/{target}/permissions/{role_id}"
| `/channels/${string}/permissions/default`
| "-/channels/{target}/permissions/default"
| `/channels/${string}/messages/${string}/reactions/${string}`
| "-/channels/{target}/messages/{msg}/reactions/{emoji}"
| `/channels/${string}/messages/${string}/reactions`
| "-/channels/{target}/messages/{msg}/reactions"
| "-/channels/{target}/webhooks"
| `/servers/${string}`
| "-/servers/{target}"
| `/servers/${string}/ack`
| "-/servers/{target}/ack"
| `/servers/${string}/channels`
| "-/servers/{server}/channels"
| `/servers/${string}/members`
| "-/servers/{target}/members"
| `/servers/${string}/members/${string}`
| "-/servers/{target}/members/{member}"
| "-/servers/{server}/members/{target}"
| `/servers/${string}/members_experimental_query`
| "-/servers/{target}/members_experimental_query"
| `/servers/${string}/bans/${string}`
| "-/servers/{server}/bans/{target}"
| `/servers/${string}/roles`
| "-/servers/{target}/roles"
| `/servers/${string}/permissions/${string}`
| "-/servers/{target}/permissions/{role_id}"
| `/servers/${string}/permissions/default`
| "-/servers/{target}/permissions/default"
| "-/custom/emoji/{id}"
| "/auth/account/disable"
| `/auth/account/verify/${string}`
| "-/auth/account/verify/{code}"
| `/auth/session/${string}`
| "-/auth/session/{id}"
| "/auth/mfa/recovery"
| "/push/unsubscribe" - Route extends PickRoutes<Method> & {
parts: Count<Path, "/", []>;
path: Path;
}
Parameters
- method: Method
- path: Path
- params: Route["params"]
Optionalconfig: AxiosRequestConfig<any>
Returns Promise<Route["response"]>
Typed Response Data
API Client